home *** CD-ROM | disk | FTP | other *** search
/ Best of Shareware / Best of PC Windows Shareware 1.0 - Wayzata Technology (7111) (1993).iso / mac / ZIPPED / DOS / EDITORS / SS24B.ZIP / SS.DOC < prev    next >
Text File  |  1992-02-09  |  24KB  |  545 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                  ShareSpell v2.4
  22.                             Text File Spelling Checker
  23.                     Copyright 1989-1992, Acropolis Software
  24.  
  25.                                  Robert Bequette
  26.                                 Acropolis Software
  27.                                   P.O. Box 5037
  28.                                Fair Oaks, CA  95628
  29.  
  30.  
  31.  
  32.  
  33.  
  34.       THE LEGAL STUFF
  35.  
  36.          ShareSpell is provided on an "as is" basis without warranty of
  37.          any kind expressed or implied. In no event will Acropolis
  38.          Software be liable to you for any damages, including any lost
  39.          profits, lost savings or other incidental or consequential
  40.          damages arising out of the use of or inability to use the
  41.          program, even if Acropolis Software has been advised of the
  42.          possibility of such damages, or for any claim by any other party.
  43.  
  44.          ShareSpell is copyrighted by Acropolis Software.  You are
  45.          encouraged to give copies to your friends and upload it to
  46.          bulletin boards.  However, sale of the program for profit by
  47.          anyone except Acropolis Software is strictly prohibited, except
  48.          for a small fee for duplication.  That fee does not register
  49.          you as a user of ShareSpell.  If you like ShareSpell and find
  50.          it useful you are asked to register as a users with Acropolis
  51.          Software.  (See "REGISTRATION" at the bottom of this document
  52.          for information on how to register).
  53.  
  54.  
  55.  
  56.  
  57.       INDEX
  58.  
  59.  
  60.  
  61.         Introduction              ......................................  1
  62.  
  63.         File list                 ......................................  1
  64.  
  65.         Requirements              ......................................  1
  66.  
  67.         Installation
  68.  
  69.           One Drive System        ......................................  2
  70.  
  71.           Two Drive System        ......................................  3
  72.  
  73.           Hard Drive System       ......................................  3
  74.  
  75.         Monitor Configuration     ......................................  4
  76.  
  77.         How to use to ShareSpell  ......................................  5
  78.  
  79.         Quick Reference           ......................................  7
  80.  
  81.         Questions or Comments     ....................................... 8
  82.  
  83.         Registration              ....................................... 9
  84.                                                                       Page 1
  85.  
  86.  
  87.  
  88.       INTRODUCTION
  89.  
  90.        ShareSpell version 2.4 is a "stand-alone" spelling checker.  With it
  91.        you can check the spelling of text files that you have written.  It
  92.        is completely interactive.  It will display the text of the file as
  93.        it goes through the file, checking for spelling errors.  At each word
  94.        that it thinks is misspelled, you'll be given the option of replacing
  95.        the word from a list of suggested correct spellings, manually
  96.        correcting it, adding it to the dictionary, marking it for later
  97.        correction, or ignoring it throughout the rest of the document.
  98.        Currently ShareSpell has a 112,000+ word dictionary, and you have the
  99.        option of adding words that you use all the time such as your name and
  100.        words specific to your field of writing.
  101.  
  102.        ShareSpell is a shareware product.  It is not "freeware" or public
  103.        domain.  If you use ShareSpell, you are expected to pay for it just
  104.        like any other program.  In return for the $20 registration fee, you
  105.        will receive the latest version of the program and the newest
  106.        dictionary on either a 5 1/4" or 3 1/2" disk (whichever you prefer).
  107.  
  108.  
  109.  
  110.       FILE LIST
  111.  
  112.         ShareSpell comes with the following files:
  113.  
  114.  
  115.            SS.EXE         The ShareSpell Program.
  116.            SS.DOC         This manual.
  117.            ACROP.DIC      The dictionary containing all the words.
  118.            SS24.NEW       New features / bug fixes for ShareSpell.
  119.            DICMAN.EXE     Dictionary Manager utility.
  120.            DICMAN.DOC     Documentation for Dictionary Manager.
  121.            DICMAN14.NEW   New features / bug fixes for Dictionary Manager.
  122.  
  123.  
  124.         It you give copies of this program away you MUST include all seven
  125.         files in their original form.  Distribution with one or more of
  126.         the files missing or altered in anyway is strictly prohibited.
  127.  
  128.  
  129.  
  130.       REQUIREMENTS
  131.  
  132.         The minimum system requirements to run ShareSpell are:
  133.  
  134.            256K of RAM
  135.            1 Floppy disk drive
  136.            MSDOS/PCDOS version 2.1 or higher
  137.  
  138.         A hard drive or two floppy drives are recommended.  A single drive
  139.         system leaves very little room for storage of the file to be checked
  140.         and its backup.
  141.  
  142.                                                                       Page 2
  143.  
  144.  
  145.  
  146.       INSTALLATION
  147.  
  148.        Single Disk Drive System Installation
  149.  
  150.         It is possible to use ShareSpell on a single-drive system, though
  151.         it will require a little more work from you and it limits the
  152.         size of the file that you can check.  Further, you will not be able
  153.         to use Dictionary Manager to alter your dictionary, since a single
  154.         drive system has too little disk space.
  155.  
  156.         Format a floppy disk and copy the files SS.EXE and ACROP.DIC to
  157.         it. It will be your working ShareSpell disk.  Here is how to do it:
  158.  
  159.         Have a blank disk ready and start up your computer with a DOS
  160.         disk in the disk drive.  Type the following:
  161.  
  162.           FORMAT A:
  163.  
  164.         When asked to insert a blank disk in drive A: take out your DOS
  165.         disk and insert the blank disk that will be you ShareSpell working
  166.         disk.  When the formatting is done, place your master ShareSpell
  167.         disk in drive A: and type the following:
  168.  
  169.           COPY SS.EXE B:
  170.  
  171.         When asked to insert the disk in drive B: take the master ShareSpell
  172.         disk out of your disk drive and insert the ShareSpell working disk.
  173.         If asked to insert the disk in drive A: take out the ShareSpell
  174.         working disk and insert the ShareSpell master disk.  Continue doing
  175.         so until you are returned to the A> prompt.  Now with your
  176.         ShareSpell master disk in drive A: type:
  177.  
  178.           COPY ACROP.DIC B:
  179.  
  180.         Follow the same procedure outlined above inserting your ShareSpell
  181.         working disk in your drive when asked to insert the disk in drive
  182.         B: and inserting your ShareSpell master disk in your drive when
  183.         asked to put a disk in drive A:.  You now have a ShareSpell working
  184.         disk.  Put your master ShareSpell disk away in a safe place so that
  185.         if something happens to your working disk you can make a new copy by
  186.         following the steps outlined above.
  187.  
  188.         To check the spelling of a file, you must copy the file to the
  189.         ShareSpell working disk first.  For example you want to check the
  190.         spelling of a file named LETTER.TXT.  First place the disk with
  191.         the LETTER.TXT file on it in your disk drive and then type:
  192.  
  193.             COPY A:LETTER.TXT B:
  194.  
  195.         Don't worry that you do not have a B: drive, MSDOS will read the
  196.         file into memory and ask you to insert the destination disk in
  197.         drive B:.  Take the disk with your file on it out of drive,
  198.         insert the ShareSpell working disk and press the RETURN key.
  199.         LETTER.TXT will be copied to the ShareSpell disk.  Now you can type
  200.         SS to start ShareSpell and check the spelling of your document.
  201.                                                                       Page 3
  202.  
  203.  
  204.         There are three things to remember when using ShareSpell on a
  205.         single-drive system.  First, you will have to copy the corrected
  206.         document back to the disk that you copied it from.  Second, the
  207.         amount of space on the ShareSpell disk is limited.  You must delete
  208.         the files that you have been checking when you are finished with
  209.         them, or you will run out of room on the ShareSpell work disk.
  210.         Third, since ShareSpell places a backup copy of the checked file
  211.         on the disk you can only check files that are half the size of the
  212.         amount of free space on your ShareSpell disk.
  213.  
  214.  
  215.  
  216.        Two Disk Drive System Installation
  217.  
  218.         Setting up ShareSpell on a two disk drive system is easy.  Start
  219.         up you computer with a DOS disk in drive A:.  Now place a blank
  220.         disk in drive B: and type:
  221.  
  222.           FORMAT B:
  223.  
  224.         When the formatting is finished, replace the DOS disk in drive A:
  225.         with your ShareSpell master disk and type the following commands:
  226.  
  227.           COPY SS.EXE B:
  228.           COPY ACROP.DIC B:
  229.           COPY DICMAN.EXE B:
  230.  
  231.         You now have a ShareSpell working disk in drive B:.  Put your master
  232.         ShareSpell disk away in a safe place so that if something happens to
  233.         your working disk you can make a new copy by repeating the steps
  234.         above.  To run ShareSpell, place the ShareSpell working disk in drive
  235.         A: and place the disk with the document you want to check the spelling
  236.         of in disk drive B: type SS to start ShareSpell.  When asked for the
  237.         name of the file to check type B: and the name of the file you wish
  238.         to correct.  An example would be B:LETTER.TXT.
  239.  
  240.  
  241.  
  242.        Hard Drive System Installation
  243.  
  244.         To install ShareSpell on your hard drive you can do one of two things.
  245.         Install it into the subdirectory that holds your MSDOS/PCDOS external
  246.         commands or install it into it's own subdirectory.  Installing it in
  247.         the MSDOS command directory is the easiest and most convenient.
  248.  
  249.         Most people with hard drives have a subdirectory called DOS, MSDOS,
  250.         PCDOS, BIN, UTILITY, or something similar that they use to store
  251.         the external commands for DOS (i.e. FORMAT, CHKDSK and so on) and
  252.         other utilities.  It usually already has the PATH set up to search
  253.         it.  If that is how you have your hard drive set up, just copy the
  254.         following files into your directory and ShareSpell is ready to use.
  255.  
  256.         Copy -> SS.EXE
  257.                 ACROP.DIC
  258.                 DICMAN.EXE
  259.  
  260.         If you do not have your external commands in the path or you do
  261.         not wish to add ShareSpell into your DOS directory, you can make
  262.         a subdirectory just for ShareSpell. Call it whatever you like. It
  263.         doesn't matter to ShareSpell.
  264.                                                                       Page 4
  265.  
  266.  
  267.       Monitor Configuration
  268.  
  269.  
  270.        You can now configure ShareSpell to display in monochrome mode
  271.        even on a color monitor.  To do so when you start ShareSpell up
  272.        give it a command line parameter of -m.  You only have to do that
  273.        the first time, after that it will remain in monochrome mode each
  274.        time you run the program again, provided that it could create the
  275.        configuration file.  If you want to switch it back to color mode
  276.        use the -c command line parameter.  When you use either of those
  277.        commands ShareSpell will create a file called SS.CFG that stores
  278.        the display type that you wish to use.  It will be placed wherever
  279.        it finds the dictionary file "ACROP.DIC" so if you move the
  280.        dictionary to a different place remember to move the "SS.CFG" file
  281.        along with it.  If you do not specify an option on the command line
  282.        ShareSpell will continue to use whatever display type it finds.
  283.        And of course you cannot specify a color display when you only have
  284.        a monochrome monitor.
  285.  
  286.          Examples:
  287.  
  288.            SS -m
  289.            SS -c myfile.txt
  290.            SS thefile.asc -m
  291.  
  292.  
  293.                                                                       Page 5
  294.  
  295.  
  296.  
  297.         You can either change to the directory that ShareSpell is in to use
  298.         it, or you can add/change the PATH command in you AUTOEXEC.BAT file.
  299.         By doing so you can use ShareSpell from anywhere (i.e. in your word
  300.         processor's subdirectory, from a floppy...).  Assuming you called
  301.         the subdirectory that you copied ShareSpell into SPELL on your C:
  302.         drive, use a text editor and add the following line to your
  303.         AUTOEXEC.BAT file:
  304.  
  305.           PATH=C:\SPELL
  306.  
  307.         It you call the directory something else or place it on a different
  308.         hard drive, change the name of the drive and subdirectory
  309.         accordingly.  If you already had a PATH command in your subdirectory,
  310.         add the ShareSpell directory by separating it from the other
  311.         directories with a semicolon:
  312.  
  313.           PATH=C:\MSDOS;C:\TURBO;C:\SPELL
  314.  
  315.         Once you have rebooted the system so that the ShareSpell subdirectory
  316.         is added to the path, you can use both ShareSpell and the Dictionary
  317.         Manager from any subdirectory.
  318.  
  319.  
  320.  
  321.       HOW TO USE SHARESPELL
  322.  
  323.       To use ShareSpell all you need is the file that you want to check the
  324.       spelling of and, of course, the ShareSpell program and dictionary.
  325.       Type SS and then press the <RETURN> key.  ShareSpell will start up and
  326.       display its opening screen.  You can use the arrow keys to move around
  327.       the screen and select the file of which you want to check the spelling.
  328.       To select the file move to it and press the <RETURN> key.  Some of the
  329.       file names really aren't files, but directories.  The files that have
  330.       <DIR> after their name instead of the file size are subdirectories in
  331.       the current directory you are in.  There also can be one other special
  332.       file name on the list ".." with the word "PARENT" after it.  If you
  333.       select that file you will be taken to the directory that contains the
  334.       subdirectory you are in.  The only directory that will not have a
  335.       parent is the root directory of the disk (either hard disk or floppy).
  336.       If you decide not to check a document just press the <ESC> key and you
  337.       will be exited from ShareSpell.
  338.  
  339.       ShareSpell now scans your document file looking for all of the unique
  340.       words and then checks the list of words to see if there are any
  341.       misspelled words.  If there are any misspellings ShareSpell will
  342.       start displaying your file stopping to show you the incorrect words.
  343.  
  344.       When ShareSpell finds a word that it does not like it, will stop and
  345.       search the dictionary to find a list of words that it thinks you might
  346.       have wanted to use instead of the current word.  On the lower right
  347.       side of the screen it will display the list of suggested words.
  348.       To the left of that you will see the list of available commands, and
  349.       just above that you will see the word that it does not like.  After
  350.       the list is displayed, you can use the following keys to make changes
  351.       to the word.  Before the list of suggestions is display you can also
  352.       use any of these commands, and ShareSpell will quit the search for
  353.       suggestions and display the list of alternative words that is has
  354.       found so far.
  355.                                                                       Page 6
  356.  
  357.  
  358.  
  359.       At this point you can use the up and down arrow keys to move through
  360.       the list of suggested spellings.  Use them to select the one that you
  361.       wish to choose.  Pressing the <RETURN> key will replace the
  362.       currently misspelled word with the highlighted word.  The empty word
  363.       at the top is a special location;  If the highlight bar is on it when
  364.       you press the <RETURN> key, the current word will be skipped and not
  365.       replaced.  If you wish to ignore all following occurrences of that word
  366.       in the document press the <ESC> key.
  367.  
  368.  
  369.       One of your other options is to correct the word manually.  When you
  370.       press either the left arrow, right arrow, or backspace, you will see
  371.       the cursor move over to the suspected word window.  Now you can use
  372.       the arrow keys to move around in the word and the <DEL> and
  373.       <BACKSPACE> key to correct the spelling manually.  Once you press
  374.       <RETURN>, the corrected word will replace the misspelling in the text.
  375.       Before doing the replacement, however, ShareSpell will check to see if
  376.       the word that results from your changes is in the dictionary.  If it
  377.       is not, it will ask you if you really want to make the replacement.
  378.       A response of <Y>es will cause the word to replace the one in the
  379.       document file.  If you respond with a <N>o you will be asked if you
  380.       want suggestions on the new spelling of the word.  If you respond with
  381.       a <Y>es, new suggestions will be given and the process start all over
  382.       again.  If you respond is a <N>o you will be taken back to editing the
  383.       word.  If you decide that you do not want to correct the word manually
  384.       use the up or down arrow to move back to the suggestion list.
  385.       Alternatively you can press any of the other command keys to perform
  386.       that command instead of the manual correction.
  387.  
  388.       Pressing the <F8> key will cause ShareSpell to add that word to its
  389.       dictionary.  From that point on that word will not be flagged as
  390.       misspelled.  If at a later date you decide that you did not want the
  391.       added word in the dictionary you can use the Dictionary Manager utility
  392.       to remove it from the dictionary.
  393.  
  394.       Pressing the <F7> key will cause ShareSpell to mark the word in the
  395.       file for you by placing a '@' character before it and before all
  396.       further occurrences of that word in the document.  The main use for
  397.       this is for cases where you think the word may be spelled correctly,
  398.       but do not have a dictionary at hand to check it.  Later, you can use
  399.       your word processor to find all the marked words by having it search
  400.       for the '@' character.
  401.  
  402.       To quit ShareSpell just press the <F10> key.  If you have made any
  403.       changes to the document, it will ask if you want to save those changes
  404.       before quitting ShareSpell.  If you answer <Y>es the updated file will
  405.       be written to disk in place of the old version and the old version will
  406.       be saved with a .BAK extension.  If you answer <N>o the file will
  407.       remain as it was before you started ShareSpell.
  408.                                                                       Page 7
  409.  
  410.  
  411.  
  412.       QUICK REFERENCE
  413.  
  414.         Starting ShareSpell:
  415.  
  416.           At the DOS Prompt type one or the following:
  417.  
  418.           SS or SS filename
  419.  
  420.         Starting ShareSpell without a file name will make it prompt you
  421.         for the name of the file to spell check.  Otherwise, it will spell
  422.         check the file you specify.  If the file does not exist, you will
  423.         be told so and asked for a new file name.  Pressing the <ESC> key
  424.         will exit you immediately from ShareSpell.
  425.  
  426.         ShareSpell will scan through the file until it finds a word that it
  427.         thinks is misspelled.  It will than give you a list of possible
  428.         correct spellings.  At that point you can press one of the following
  429.         keys:
  430.  
  431.         <RETURN>
  432.           To accept the word as is and continue.
  433.  
  434.         <ESC>
  435.           To ignore the word in the document.  This is useful for words such
  436.           as proper names that you know are spelled correctly, but do not
  437.           want to add to the dictionary.
  438.  
  439.         <F7>
  440.           Mark and ignore the word.  Place a "@" in front of the word and
  441.           all later occurrences of it so that you can find it later with your
  442.           word processor.
  443.  
  444.         <F8>
  445.           To add the current word to the dictionary.  Good words to add are
  446.           things such as your name or other proper nouns that you use often.
  447.  
  448.         <UP ARROW>
  449.         <DOWN ARROW>
  450.           To select one of the alternative spellings.  When the word you want
  451.           to replace the misspelled word with is highlighted press the
  452.           <RETURN> key and it will be replaced.
  453.  
  454.         <LEFT ARROW>
  455.         <RIGHT ARROW>
  456.           To correct the current word manually.  After you press one of the
  457.           arrow keys you can use the <DEL>, <BACKSPACE>, and arrow keys to
  458.           edit the misspelling.  When you have it corrected, press the
  459.           <RETURN> key to replace it in the document.  Otherwise pressing
  460.           the up or down arrow will bring you back to the list of suggestions.
  461.  
  462.         <F10>
  463.           Quit ShareSpell.  If you have made any changes ShareSpell will ask
  464.           if you want to save the changes made so far.
  465.  
  466.  
  467.         Use the selected keys until you have corrected all of the document and
  468.         ShareSpell ends or until you end ShareSpell with the <F10> key.
  469.                                                                       Page 8
  470.  
  471.  
  472.  
  473.       QUESTIONS OR COMMENTS
  474.  
  475.       If you have any questions or comments I can be reached through the
  476.       U.S. Mail at:
  477.  
  478.          Acropolis Software
  479.          P.O. Box 5037
  480.          Fair Oaks, CA  95628
  481.  
  482.  
  483.       Or electronically:
  484.  
  485.          On CompuServe by sending EasyPlex mail to 75146.3471
  486.                                                                       Page 9
  487.  
  488.  
  489.  
  490.       REGISTRATION
  491.  
  492.       As the name implies it is a shareware product.  This is not a demo or
  493.       crippled version of ShareSpell, but a full working version as all the
  494.       earlier releases have been.  If you use ShareSpell, I ask you to send
  495.       $20 to Acropolis Software to register your copy in return you will
  496.       receive a disk containing the latest version of both the program and
  497.       the dictionary.  When you register your copy of ShareSpell, please use
  498.       the order form below. If you do not use the form, please specify that
  499.       you are registering ShareSpell and indicate your preferred disk format
  500.       (5 1/4" or 3 1/2").
  501.  
  502.       Purchases of 10 or more copies will receive a site license package
  503.       with consists of a master copy of the latest version and an agreement
  504.       that you can make the specified number of copies.  Site license are
  505.       charged $10.00 per copy they wish to make.
  506.  
  507.       The spell checking technology is also available for purchase.  Contact
  508.       me for more information.
  509.  
  510.  
  511.     _______________________________________________________________________
  512.  
  513.                                Registration / Order Form
  514.  
  515.  
  516.      Name       : __________________________
  517.      Company    : __________________________
  518.      Address    : __________________________
  519.                   __________________________
  520.      City/State : __________________________
  521.      Zip Code   : __________________________
  522.  
  523.      (Optional)
  524.      Phone      : __________________________
  525.  
  526.  
  527.  
  528.      Basic registration (less than 10 copies)      : $20 x ___ = $ ______
  529.      Site license registration (10 or more copies) : $10 x ___ = $ ______
  530.              ** California residents please add sales tax.  **
  531.  
  532.      Disk Format:    5 1/4" ___    3 1/2"  ___
  533.  
  534.      The product being registered is ShareSpell v2.4.
  535.      You will receive a registered copy of the latest version of ShareSpell
  536.      without the shareware screen at the end, the latest dictionary and
  537.      related utilities.
  538.  
  539.      Send check or money order to:
  540.  
  541.          Acropolis Software
  542.          P.O. Box 5037
  543.          Fair Oaks, CA  95628
  544.  
  545.